Tangible Software Solutions

Instant VB Help


Contents

  1. Project & Folder Conversion
  2. File & Snippet Conversion
  3. Command Line Conversion
  4. Code Formatting Options
  5. Conversion Message Options
  6. Custom String Replacements
  7. Diagnostic Options
  8. File Encoding Options
  9. Project Conversion Groups
  10. Default Shared Assemblies for Conversions
  11. Assumed Imported Namespaces for Snippet Conversions
  12. Project Conversion Options
  13. Additions & Omissions
  14. Miscellaneous Options
  15. Assembly Resolution


Project & Folder Conversion

The Project & Folder Converter tab allows you to convert all C# code within a project, solution, or folder. Once the conversion is finished, you can then launch the new project or solution, view Instant VB comments, compare converted code files to original code files, and view the new project or solution folder.

The folder conversion option allows you to convert all C# code within a folder hierarchy.

The Conversion History listview displays previously converted projects and allows you to launch the project, view remaining Instant VB comments, and view the project folder.


File & Snippet Conversion

The File & Snippet Converter tab allows you to convert C# code snippets or files. From the left side textbox, you can type or paste code snippets, insert files, or view Instant VB sample snippets. Once a file or snippet is converted, you can select and copy the results, save the results to a file, or search the results.


Command Line Conversion

Instant VB can be launched from the command line with one or two parameters plus an optional last parameter indicating the location of a conversion options file. If only one parameter is specified, it is interpreted as the name of one of your custom project conversion groups. If two parameters are specified, the first parameter is either a C# project file, solution file, folder, or file that you wish to convert, and the second parameter is the folder or file that the converted VB project will be written to. If the optional last parameter indicating the location of a conversion options file is included, then that file is imported before the conversion starts. A conversion options file has the extension '.opt' and is produced by exporting existing options to an xml file from the converter.

e.g. (project group conversion),
"Instant VB" "MyProjectGroup"

e.g. (single project conversion),
"Instant VB" "C:\C# Projects\Sample Project.csproj" "C:\VB Projects\Sample Target Folder"

e.g. (solution conversion),
"Instant VB" "C:\C# Projects\Sample Solution.sln" "C:\VB Projects\Sample Target Folder"

e.g. (folder conversion),
"Instant VB" "C:\C# Projects\Sample Source Folder" "C:\VB Projects\Sample Target Folder"

e.g. (file conversion),
"Instant VB" "C:\C# Source Files\testfile.cs" "C:\VB Converted Files\testfile.vb"

e.g. (folder conversion with a conversion options file specified),
"Instant VB" "C:\C# Projects\Sample Source Folder" "C:\VB Projects\Sample Target Folder" "C:\Options\Instant VB.opt"

Once the command line conversion is complete, Instant VB will shut down.

Note that Instant VB must be in double quotes since the executable name contains a space.


Code Formatting Options


Conversion Message Options

On this options dialog, you can customize the comment prefixes that the converter uses for messages and also toggle the messages that Instant VB displays on or off.

You can easily set all or none to display via the 'Select All' and 'Select None' buttons.


Custom String Replacements

Instant VB allows you to specify your own custom replacements in the converted VB code. This can be useful for customizing code according to style preferences that may be different in VB than in C#. It's also useful for cases where a C# method without a good VB equivalent will be replaced by your own custom method to be called from the converted code.

For each replacement string you can specify the regex option, when to perform the replacement (pre or post conversion), whether or not to match case, whether to match whole words only, and whether comments or string literals should be modified. The whole words and string literals options do not apply if the regex option is selected.

To span mulitple lines, either paste directly into the 'Find' and 'Replacement' textboxes, or use the escaped characters: \r\n\t.

The "Active" checkbox can be unchecked if you wish to temporarily bypass the replacement.

Replacements are made in the order that they appear on the options dialog. For example, the second replacement is made to each line of code after the first replacement has already been made. To change the order of replacements, use the 'Up' and 'Down' buttons.

For an example of the regex option, you could do a custom replacement of "Foo(x)" with "Bar(x)", where "x" is any argument, by specifying the "Find" field as "Foo(([\sa-zA-Z_$]*))" and the "Replace" field as "Bar$1". Note that there are differences in various regex engines - the regex engine used by the converter is .NET System.Text.RegularExpressions.Regex.


Diagnostic Options

These options are intended to provide information to Tangible Software Solutions if a conversion is taking longer than expected. 'Record processing by file' instructs the converter to make a record of the files processed and the time taken for each process. 'Record the last 100 lines of code parsed before cancelling conversion' instructs the converter to make a record of the most recent lines parsed before you cancelled the conversion.


File Encoding Options

The converter detects input file encoding from the byte order mark (BOM), but if the BOM is missing the converter assumes by default that the file encoding is UTF-8. You can use this option to specify a different default encoding to use in the absence of a BOM. Output is written in the same encoding as the encoding detected for the original file, or your default encoding option if the original coding was not detected via the BOM. For UTF-8, you can choose whether or not to include the BOM for the output - this is normally used in Windows environments.


Project Conversion Groups

If you need to regularly convert many projects at the same time, use the Conversion Groups feature. This is most commonly used to convert sets of sample projects to VB.

To configure Conversion Groups, go to Options->Project Conversion Groups on the main menu or toolbar.

To convert a Conversion Group, go to Convert->Convert Group on the main menu.


Default Shared Assemblies for Conversions

For snippet and folder conversions, you can specify the assemblies that the converter should resolve when interpreting the original code.

For .NET Core SDK projects, the project file contains no information about the shared assemblies used by the project. The converter will not automatically attempt to resolve every assembly in the .NET Core shared assembly location since it takes time to resolve the type information in each assembly. Instead, we resolve only the shared assembly defining the core types (System.Private.CoreLib) and allow you to select other assemblies for each project SDK that you typically use.

For .NET Framework SDK projects, the project file contains no information about the GAC assemblies used by the project. The converter will not automatically attempt to resolve every assembly in the .NET Framework GAC assembly location since it takes time to resolve the type information in each assembly. Instead, we resolve only the GAC assemblies 'mscorlib' and 'System' and allow you to select other assemblies for each project SDK that you typically use.


Assumed Imported Namespaces for Snippet Conversions

You can specify namespaces that you would like the snippet converter to assume are available when interpreting the original code. The snippet converter will then convert as if the snippet contained the corresponding 'using' directives.


Project Conversion Options


Additions & Omissions


Miscellaneous Options


Assembly Resolution

Assemblies referenced by projects are examined to determine the nature of the types and members within the assembly to improve the conversion quality.

During the project conversion process you may be prompted by the converter to find specific assemblies referenced by your project if they cannot otherwise be found by the converter.

If the converter does not resolve all assemblies, you can still continue the project conversion, but the conversion may not be optimal for code which references the unresolved assemblies. This just means that a few more manual adjustments may be required.

If the assembly does not require an install, you can forward it to us in a zip file to determine why it is not resolving.


Copyright © Tangible Software Solutions, Inc.